v1.18.0 Release Notes

Zadig v1.18.0 was released on August 11, 2023.

# Feature List

Workflow

• Custom workflows support failure retry
• Custom workflow deployment tasks support image search
• Custom workflows support code information transfer
• Custom workflow test tasks support code repository information and environment variables
• Custom workflow general tasks support PROJECT variable
• Custom workflow deployment tasks support selecting all service components during execution
• Product workflow delivery deployment tasks support selecting all service components
• Custom workflow deployment tasks display service configurations when not yet started
• Workflow trigger configuration for build tasks no longer selects service components by default
• Gerrit commits in workflow details can be clicked to navigate to review page
• Custom task configurations in workflows support synchronization from other types of code sources
• Code scanning includes available variable hints
• Code scanning triggers support configuring multiple code repositories
• File storage and binary storage steps in build/test support built-in variables for code repository information
• Workflow list hover functionality supports displaying complete workflow names

Performance

• Improved loading efficiency for workflow build task configuration pages
• Improved loading efficiency for project list pages
• Improved loading efficiency for template-based build pages
• Improved loading efficiency for workflow execution pages
• Improved loading efficiency for environment pages

Environment

• Removed dry run check when deploying services in K8s YAML projects
• Removed dry run check when deploying services in K8s Helm Chart projects
• Improved service variable usability in K8s YAML projects
• When environment images have never been updated, support image updates through service configuration modification

System

• Enhanced system security and login password validation
• Operation logs record permission management related operations
• JIRA integration supports Access Token authentication
• Added create project permission
• Performance insights support project selection
• Support fuzzy search by project identifier/project name/pinyin
• Support sorting images by creation time
• Direct connection mode cluster access no longer installs hub-agent
• Deprecated Resource Server component to improve system maintainability
• Added user initialization during system installation

Experience and Interaction Optimization

• Improved page refresh experience after Zadig upgrades
• Added new environment entry when no environment resources exist in project
• Optimized build code information input interaction
• Optimized workflow execution page interaction
• Service YAML editor can adaptively adjust optimization
• Custom workflow log scrolling interaction optimization
• Custom workflow variable source selection items display selected state
• Custom workflow deployment task variable configuration optimization
• Custom workflow task detail page display optimization
• Environment service list scrolling interaction optimization
• Performance insights page interaction optimization
• Tooltip position optimization when configuring services in managed projects
• User list information display optimization
• Improved new cluster creation interaction experience
• Enhanced system integration page interaction experience
• Deleting projects no longer deletes namespaces and services by default
• Deleting environments no longer deletes namespaces and services by default
• Helm Chart project deployment task service components from preceding tasks preview with image change descriptions
• Custom workflow general task execution includes code repository information display scope

Bug Fixes

• Fixed workflow view editing error issue
• Fixed build template left panel unable to drag right issue
• Fixed build template 403 error when no permissions issue
• Fixed regular users accessing system settings permissions issue
• Fixed popup accidentally closing issue
• Fixed Helm Chart deployment task preview inaccuracy issue
• Fixed occasional GitLab token failure when timer/webhook triggers workflow issue
• Fixed workload not restarting when updating service YAML with no changes in environment issue
• Fixed preview failure caused by "." variables in Chart Values issue
• Fixed Chart view scrollbar anomaly issue
• Fixed service deployment timeout setting not taking effect issue
• Fixed YAML template changes in services not taking effect issue
• Fixed incomplete test task log display issue
• Fixed workflow task execution failure due to unstable cluster network issue
• Fixed occasional product workflow task queuing due to network instability issue
• Fixed inconsistent image generation rules between product workflows and custom workflows issue
• Fixed custom workflow not sending notifications on failure issue
• Fixed custom workflow task preparation environment stage duration not displayed issue
• Fixed custom workflow test tasks unable to configure custom variables issue
• Fixed invalid {{.workflow.task_id}} variable in custom workflows issue
• Fixed add service button not showing when scrolling on small screens during custom workflow build configuration issue
• Fixed execution parameters being reset due to service component selection changes on workflow execution page issue
• Fixed default branch information loss for other code sources when executing custom workflows issue
• Fixed unable to retry failure when skipping a stage in custom workflow execution issue
• Fixed ability to modify service configuration after creating service based on template with auto-sync enabled issue
• Fixed undefined display when configuring host resources for services in host scenario guidance process issue
• Fixed host project product workflow unable to configure newly added services issue

# Business Change Notice

# Service Variable Changes

1. If nested variables are used in service configuration, ensure multiple variables have consistent visibility. For example, in the following case, ports_config[].protocol and ports_config[].container_port need to have consistent visibility.

apiVersion: apps/v1
kind: Deployment
spec:
  spec:
    containers:
      - name: $T-Service$
        ports:
        {{- range .ports_config}}
          - protocol: {{.protocol}}
            containerPort: {{.containerPort}}
        {{- end}}
        ...more content omitted...

2. For invisible service variables in service configuration, explicitly declare them in the environment's global variables.

Service variable visibility configuration can be found in the documentation: Variable Settings.

# Built-in Software Package Changes

Built-in software package download addresses changed to official addresses, with the following new built-in software packages added:

• node 12.22.12, node 14.21.3, node 16.20.2, node 18.17.1
• java 1.8.20, java 1.11.0.2
• go 1.20.7

Some older version software packages deprecated:

• java 1.6.6, java 1.7.8, java 1.9.0.1, java 1.10.0.2
• ginkgo 1.6.0, ginkgo 2.2.0, ginkgo 2.3.1, ginkgo 2.4.0
• go 1.8.5, go 1.9.7, go 1.10.2, go 1.11.5, go 1.12.9
• node 8.11.4, node 8.15.0, node 16.18.1, node 18.12.1
• jMeter 3.2, jMeter 5.4.3
• php 5.5
• dep 0.4.1

# Version Upgrade Process

# Database Backup

If already in production use, be sure to backup the database before upgrading

1. Database backup commands:

• Backup MongoDB data

mongodump -h IP --port PORT -u USERNAME -p PASSWORD -d DATABASE -o FILE_PATH

• Backup MySQL data

mysqldump -h <HOST> -P <PORT> -u root -p user > user.sql
mysqldump -h <HOST> -P <PORT> -u root -p dex > dex.sql

2. Database restore commands:

• Restore MongoDB data

mongorestore -h IP --port PORT -u USERNAME -p PASSWORD -d DATABASE --drop FILE_PATH

• Restore MySQL data

# Execute the following in MySQL:
mysql> drop database user;
mysql> create database user;
mysql> drop database dex;
mysql> create database dex;
# Execute the following data recovery operations from command line:
mysql -h <HOST> -P <PORT> -u root -p user < user.sql
mysql -h <HOST> -P <PORT> -u root -p dex < dex.sql

# Upgrade Operations

Please execute corresponding upgrade steps according to different installation methods.

# Installation Method: All in One Installation Mode or Installation on Existing Kubernetes

For both installation methods, use the script from Installation on Existing Kubernetes^New for upgrade.

# Installation Method: Helm Command Installation

For this installation method, execute the following steps to upgrade to v1.18.0:

1. Execute the following command to backup installation parameters and save as zadig.yaml file.

helm get values <Release Name> -n <Zadig Namespace>  > zadig.yaml

2. Execute upgrade command according to installation method.

• Domain method:

export NAMESPACE=<Zadig Installation NAMESPACE>

helm repo update
helm upgrade -f zadig.yaml <release_name> koderover-chart/zadig --namespace ${NAMESPACE} --version=1.18.0

• IP + PORT method:

export NAMESPACE=<Zadig Installation NAMESPACE>
export PORT=<Any port between 30000-32767, different from initially used port>

helm repo update
helm upgrade -f zadig.yaml <release_name> koderover-chart/zadig --namespace ${NAMESPACE} \
    --set gloo.gatewayProxies.gatewayProxy.service.httpNodePort=${PORT} \
    --set gloo.gatewayProxies.gatewayProxy.service.type=NodePort --version=1.18.0

# [Optional] Post-Upgrade Operations

In the new version, the resource-server component is deprecated. The component in the koderover-agent namespace of connected clusters no longer performs actual Zadig-related work and can be manually deleted.